Correct and update comment on TTYPort #183
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey 🪼,
this aims to fix #180.
This change alters the comment around the
TTYPort
struct. It removes mentions of old functions/methods no longer in the code base. It adds a tiny example on how to open a tty port the correct way.Additionally: Sneaks in a tiny fix for an spelling error further down the comment.
I am unsure how to test my change. I think it is important someone rebuilds the docs and checks that my code block is rendered as expected.